The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest450 COM module
IForms::GetNextObject method | |||
---|---|---|---|
Retrieves the next form space record.
VARIANT_FALSE is returned if the end of the record list is reached. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IForms/GetNextObject | ||
[JSON input data] | pIForms: | longValue, //interface address |
|
[JSON result data] | pbstrUID: pbstrOID: pbstrName: peIsFile: pbstrFile: pbStatus: |
"utf8StringValue", "utf8StringValue", "utf8StringValue", longValue, "utf8StringValue", booleanValue |
|
[HTTP result status] | 200 | Return status 200 signals a successful method call | |
204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
>= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
C/C++ calling syntax | |||
HRESULT GetNextObject( | BSTR
BSTR BSTR YesNoType BSTR VARIANT_BOOL |
*pbstrUID,
*pbstrOID, *pbstrName, *peIsFile, *pbstrFile, *pbStatus); |
|
[C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
S_FALSE | This value is returned if the end of an iteration is reached | ||
E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||
Calling argument description | |||
[out] BSTR | *pbstrUID | The UID of the form space node or PDF form template.
The UID might be empty if such an UID can not be found |
|
[out] BSTR | *pbstrOID | The medForms OID of the form space node or PDF form template. Note that the supplied OID is always supplied in its shortened form ( e.g. medforms.20.30.5050)
This OID can be used in the IGeneralFormRequestManager::LoadPDF method to load this PDF template. |
|
[out] BSTR | *pbstrName | The descriptive name of the form space node or PDF form template | |
[out] YesNoType | *peIsFile | A Boolean denoting if the object is a node (enNo) or a PDF form template (enYes) | |
[out] BSTR | *pbstrFile | The name of the PDF form template if eIsFile=enYes or empty otherwise
Alternatively to the OID this file name can be used in the IGeneralFormRequestManager::LoadPDF method to load this PDF template. |
|
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |